SftTree/OCX 7.0

SftTree.ColumnStyle Property

Softel vdm, Inc.

Defines the cell style in the specified column.

Deprecated - Provided for compatibility with earlier versions only - Use Column.CellHAlign, Column.CellVAlign, Column.CellMultiline, Column.ToolTip, Column.CellWordWrap, Header.Locked, Header.KeepPosition, Column.Merge, Column.MergeInto instead

Syntax       

Get

VB.NET

Style = object.get_ColumnStyle(ByVal ColIndex As Short)  As SftTreeColumnStyleConstants

VB

Style = object.ColumnStyle(ByVal ColIndex As Integer)  As SftTreeColumnStyleConstants

C#.NET

SftTreeColumnStyleConstants Style = object.get_ColumnStyle(short ColIndex);

VC++

enum SftTreeColumnStyleConstants Style = object->ColumnStyle[short ColIndex];
enum SftTreeColumnStyleConstants Style = object->GetColumnStyle(short ColIndex);

C

HRESULT object->get_ColumnStyle(short ColIndex, enum SftTreeColumnStyleConstants* Style);

Delphi

Style := object.ColumnStyle[ColIndex : Smallint]  : TOleEnum;

Put

VB.NET

object.set_ColumnStyle(ByVal ColIndex As Short, ByVal Style As SftTreeColumnStyleConstants)

VB

object.ColumnStyle(ByVal ColIndex As Integer) = Style  As SftTreeColumnStyleConstants

C#.NET

void object.set_ColumnStyle(short ColIndex, SftTreeColumnStyleConstants Style);

VC++

enum SftTreeColumnStyleConstants object->ColumnStyle[short ColIndex] = Style;
void object->PutColumnStyle(short ColIndex, enum SftTreeColumnStyleConstants Style);

C

HRESULT object->put_ColumnStyle(short ColIndex, enum SftTreeColumnStyleConstants Style);

Delphi

object.ColumnStyle[ColIndex : Smallint] := Style  : TOleEnum;

object

A SftTree object.

ColIndex

The zero-based column number.

Style

Defines the cell style in the specified column.

One value of each of the following tables can be combined and used as Style value (use Column.CellHAlign, Column.CellVAlign instead):

Horizontal Alignment

Value

Description

colstyleSftTreeLeft

0

The text and graphic component are left aligned.

colstyleSftTreeCenter

1

The text and graphic component are centered.

colstyleSftTreeRight

2

The text and graphic component are right aligned.

Vertical Alignment

Value

Description

colstyleSftTreeVCenter

0x1000 (4096)

The text is vertically centered.  If no vertical alignment value is specified, this is the default.

colstyleSftTreeTop

0x2000 (8192)

The text is aligned with the top of the available area.

colstyleSftTreeBottom

0x4000 (16384)

The text is aligned with the bottom of the available area.

The values in the above table can be combined with the following values using a bit-wise Or operator.

Style

Value

Description

colstyleSftTreeMultiline

0x0004 (4)

Cell text may contain CR/LF (carriage-return, line-feed) characters which signal the start of a new line.  If multi-line text is allowed, the Items.Lines property can be used to reserve sufficient space.  Use Column.CellMultiline instead.

colstyleSftTreeToolTip

0x0008 (8)

Displays ToolTips for the column if the cell text and/or graphic component are clipped.  Also see the Items.ToolTipAlways property.  Use Column.ToolTip instead.

colstyleSftTreeWrap

0x0010 (16)

Cell text may word-wrap within the available space.  The Items.Lines property should be used to define the (maximum) number of text lines allowed.  Word-wrap is only available if colstyleSftTreeMultiline is also used.  If colstyleSftTreeMultiline is not given, colstyleSftTreeWrap is ignored.  Use Column.CellWordWrap instead.

colstyleSftTreeLocked

0x0100 256

The column width is locked and the user cannot resize the column.  This can be used to hide certain columns.  By setting a column's width to 0 and locking it, a user cannot make the column visible.  Use Header.Locked instead.

colstyleSftTreeKeepPos

0x0200 (512)

The column must remain in the current column position.  Columns on the left can be reordered but cannot be moved to the right of the column and vice versa.  This is usually used with the first column, to prevent the user from changing its position when using column drag & drop.  Use Header.KeepPosition instead.

colstyleSftTreeMerge

0x0400 (1024)

Allows the contents of this column to merge into the next displayed column if the contents of the next cell (or column header) are empty and the next column allows being merged into (colstyleSftTreeMergeInto).  This style also applies to column headers.  Use Column.Merge instead.

colstyleSftTreeMergeInto

0x0800 (2048)

Allows the contents of the previous column to merge into this column if the cell (or column header) in this column is empty.  This style also applies to column headers.  Use Column.MergeInto instead.

Comments

Deprecated - Provided for compatibility with earlier versions only - Use Column.CellHAlign, Column.CellVAlign, Column.CellMultiline, Column.ToolTip, Column.CellWordWrap, Header.Locked, Header.KeepPosition, Column.Merge, Column.MergeInto instead

The ColumnStyle property defines the cell style in the specified column.

The Style value defined using the ColumnStyle property applies to all cells in the column specified.  Individual cells can override the defined default alignment using the Cell.TextHAlign, Cell.TextVAlign, Cell.ImageHAlign and Cell.ImageVAlign properties.

To define the column header's text alignment, use the Header.TextHAlign and Header.TextVAlign properties instead.

See Also  SftTree Object | Object Hierarchy


Feedback / comments / error reports for this topic
© 2015 - Softel vdm, Inc. - www.softelvdm.com